home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 2 / The Arsenal Files 2 (Arsenal Computer).ISO / health / dwpass.exe / MAIN.TXT < prev    next >
Text File  |  1994-04-16  |  11KB  |  271 lines
  1.           ***************************************
  2.     ********** PRESS F1 FOR HELP - PRESS F2 TO PRINT **********
  3.           ***************************************
  4.  
  5.  
  6.  
  7.               Main System Documentation
  8.                
  9.                DISABILITY WORKS, INC.
  10.  
  11.            "Professional PASS Service Tracking Software"
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18. Developed by
  19.  
  20. Tom H. Emmons Jr.
  21. DisAbility Works, Inc.
  22. (303) 985-3376 V/TDD
  23. (303) 989-6156 BBS
  24. Copyright (c) DisAbility Works, Inc. 1993,1994
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31. I.   INTRODUCTION - The Common System Elements
  32.  
  33. DisAbility Works software has been developed specifically to aide the 
  34. development and monitoring of Social Security Work Incentives.  This portion 
  35. of the documentation describes many of the elements and functions that 
  36. provide a common user interface to all of our software. 
  37.  
  38.  
  39. II.   INSTALLATION - How To Get the System Up and Running!
  40.  
  41. The installation routine will create a directory on your C: Drive and place 
  42. the program files in it.  The directory's name will depend on the particular 
  43. program you are installing.  The installation procedure will also create a 
  44. batch file (e.g. PASS.bat) in your root directory.  You may run the program by 
  45. simply typing the name of the batch file at DOS Prompt (C:\>) and pressing 
  46. Enter.
  47.  
  48. After getting the system up and running, the first thing you should do with 
  49. any of our software programs is to enter information in the Customer database.  
  50. This provides information to the other program modules to be used in the 
  51. service tracking process.
  52.  
  53.  
  54.  
  55. III.   A WORD ABOUT DATABASES
  56.  
  57. Like many other disciplines, working with a database requires an understanding 
  58. of a few concepts and terms, to help us all communicate in the same language.  
  59. A database is itself a logical collection of information--as in a collection 
  60. of recipes, a phone book, or an inventory of merchandise, or, as in PASSLog, 
  61. a collection of customer service information.  Computerized databases allow 
  62. this information to be stored in a specific manner allowing very rapid 
  63. manipulation of the information contained within.  It allows, among many other 
  64. powerful features, instant access to any information contained within.  
  65. Another important and powerful feature of a database is its ability to sort 
  66. the data and generate reports based on that sorted information.  For example, 
  67. if you needed to know how many clients you had in a certain ZIP Code, the 
  68. database would be able to generate this report for you.  To provide the 
  69. flexibility to generate these reports, the database stores information into 
  70. logical groupings.  The following terms describe these groupings:
  71.  
  72. FILE - A collection of all of the information (or records) contained within 
  73. one database.  As in the Customer Information records.  In DWTRACK, the 
  74. Customer and PASS Tracking data are contained within separate database files.
  75.  
  76. RECORD - A database record is a complete, logical grouping of data (or fields) 
  77. needed to collate all data for one entity; as in all of the fields of data for 
  78. one Customer Information record--one customer's data.
  79.  
  80. FIELD - Each separate entry within a database record.  The more distinct each 
  81. field is, the more flexible the database will be during report sorting and 
  82. generation.  You use the TAB Key, or the Up or Down Arrow keys, or the (Enter 
  83. key, to jump from field to field on the screen.
  84.  
  85.  
  86.  
  87. IV.   CUSTOMER INFORMATION WINDOW - Your database interface!
  88.  
  89. Let's start with the Customer database. You must always start by entering the 
  90. basic data on new customers before tracking their services. Look at your 
  91. "Customer Information" window in the middle of the screen. Along the top of 
  92. the screen are several control menus that allow access to all of the various 
  93. commands, or features, of the software.  As you navigate through the various 
  94. options available within the control menus (using the arrow keys) a help line 
  95. at the bottom of the screen provides a small reminder about the function of 
  96. the currently highlighted item. 
  97.  
  98. The most prominent item on the initial Customer screen is the Customer 
  99. Information window. This window is your primary interface, or view-port, into 
  100. your collection of customer data.  It is your tool for inserting, editing, and 
  101. displaying the customer data within the database.  The Customer Information 
  102. window is logically divided into several "fields" of information.
  103.  
  104. 1st Contact - Edit/View the date of first contact for this customer.
  105.  
  106. ID # - Edit/View the ID # for this customer.
  107.  
  108. First - Edit/View the customer's first name.
  109.  
  110. Last - Edit/View the customer's last name.
  111.  
  112. SSN - Edit/View the customer's Social Security Number.
  113.  
  114. Phone - Edit/View the customer's phone number.
  115. Address - Edit/View the customer's address.
  116.  
  117. City/S/Zip - Edit/View the customer's City, State and/or Zip Code.
  118.  
  119. Status - Edit/View the customer's PASS status.  Pressing F2 provides a 
  120. selection window to chose from various status options.
  121.  
  122. Notes - Edit/View any notes maintained for this customer.  The notepad may 
  123. be accessed by pressing the spacebar while in the Customer Information window, 
  124. or by selecting NOTES from the File Operations menu.
  125.  
  126. Since the operation of the Customer Information window is controlled through 
  127. the use of the File Operations menu, we will proceed to that section to cover 
  128. the details.
  129.  
  130.  
  131. V.   FILE OPERATIONS - Creating & Viewing Your Information Database!
  132.  
  133. As obvious as the Customer Information window, the File Operations menu is 
  134. readily poised for action upon program startup as the logical first step in 
  135. the any of the database systems.  The commands available in the File 
  136. Operations menu operate as follows:
  137.  
  138. ADD - Selecting this command places you directly into a blank Information 
  139. window to add a new record to the database.
  140.  
  141. EDIT - This command places the cursor in the Information window allowing you 
  142. to edit (change) information in an existing record.
  143.  
  144. BROWSE - This command overlays a window arranged in columns of data from all 
  145. records in the database, allowing you to browse or scroll through them.
  146.  
  147. NEXT - This command will page to the next record in the database.
  148.  
  149. PREVIOUS - This command will page to the previous record in the database.
  150.  
  151. FIRST - Selecting this command jumps you to the first record in the database.
  152.  
  153. LAST - Selecting this command jumps you to the last record in the database.
  154.  
  155. DEL - This command will flag the current record for deletion.  To actually 
  156. remove the record from the database file, you must go into the Utility Menu 
  157. and select Pack - Re-index to either pack or re-index the database.  Any 
  158. records flagged for deletion will be deleted at that time.
  159.  
  160. NOTES - This command opens a Note/Memo Pad window on the screen allowing you 
  161. to maintain notes pertaining to the selected database record.
  162.  
  163. ORDER - This command displays a Set Index window allowing you to select the 
  164. BROWSE and/or SEEK orders.
  165.  
  166. SEEK - This command seeks for the database record  based on the previously 
  167. designated ORDER command.
  168.  
  169. FILTER - This command allows the designation of a filter, or parameters, for 
  170. the display of specific records.  You set the Filter, such as State=CO, to 
  171. have the database show only customers' records that fit the condition. 
  172.  
  173. EXIT - This command displays an exit window allowing you to exit the program, 
  174. or, resume database operations.
  175.  
  176.  
  177.  
  178. VI. Utilities Menu!
  179.  
  180. Selecting this choice displays the Utility menu allowing you to use one of 
  181. the following powerful utilities:
  182.  
  183. 1.  Backup
  184. The backup option allows you to backup the files of your choice to the 
  185. destination of your choice.  It also allows you to retrieve that data when 
  186. necessary.  When this option is selected the screen is replaced with the 
  187. Backup/Restore Utility screen containing several prompts and commands.  Near 
  188. the top of the screen are the following three prompts:
  189.  
  190. Source Path. . .  \:DW\  (for example)
  191. Source File. . .    *.DB?
  192. Target Drive . . .  A
  193.  
  194. The Source Path allows you to specify the subdirectory in which the backup 
  195. files will be copied from.
  196.  
  197. The Source File prompt allows you to specify which files are to be copied 
  198. (or backed up), the default is *.DB?, meaning all files having an extension 
  199. starting with the letters "DB."
  200.  
  201. The final prompt allows you to specify the "Target Drive," or, the drive name 
  202. which the backup files will be copied to.  Preferably to a floppy disk to 
  203. protect your data in the event of hard drive failure.  To modify these prompts, 
  204. select the Edit command at the bottom of the screen.
  205.  
  206. NOTE: If you are unfamiliar with DOS global parameters and/or subdirectories, 
  207. please refer to the appropriate sections of your DOS manual.
  208.  
  209. Along the bottom of the screen is a menu containing the following commands:
  210.  
  211. Edit - This command allows you to modify the prompts defined above.
  212.  
  213. Backup - This command initiates the backup copying procedure after the correct 
  214. entries are specified as described above.  Ensure that your backup floppy disk 
  215. is located in the specified drive prior to initiating this command.
  216.  
  217. Restore - This command will restore previously saved files (the specified 
  218. backup files) from the specified floppy drive to the specified subdirectory.  
  219. Ensure that your backup floppy disk is located in the specified drive prior 
  220. to initiating this command.
  221.  
  222. QUIT - This command will exit the BACKUP/RESTORE UTILITY to the main menu 
  223. screen.
  224.  
  225.  
  226. 2.  Pack - Re-index
  227.  
  228. This utility is used to reorganize your database files after a record has been 
  229. flagged for deletion or when a different index is specified.  Since database 
  230. files are strictly formatted, these procedures are contained within separate 
  231. utilities in an attempt to make the data files less cumbersome and time 
  232. consuming during normal operations.  The result is a speedier and more 
  233. efficient database program.
  234.  
  235. When this utility is selected, the File Utility screen is displayed.  This 
  236. screen displays the available database files, each having an associated file 
  237. number and file description.  A menu bar containing the following commands is 
  238. displayed along the bottom of the screen:
  239.  
  240. All-Select - This command will select all of the listed files for packing or 
  241. re-indexing.
  242.  
  243. Select-unselect - This command replaces the menu bar with a prompt allowing 
  244. the selection or, alternately, unselection of any of the numbered database 
  245. files.
  246.  
  247. PACK - This command executes the Pack procedure on the selected database 
  248. files.
  249.  
  250. RE-INDEX - This command executes the Re-index procedure on the selected 
  251. database files.
  252.  
  253. EXIT - This command Exits the File Utility and returns to the main PASSLog 
  254. screen.
  255.  
  256.  
  257. 3.  Database Utilities (DBU)
  258. This utility is very powerful and contains many features for the configuration 
  259. of your database files and is intended for technical support use only.
  260.  
  261.  
  262. All main data areas of the different programs follow the same guidelines as 
  263. described in the customer database section.  Refer to the individual program 
  264. guide for more information.
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.